home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / src / demos / demobook / demobook.manPage < prev    next >
Encoding:
Text File  |  1994-08-02  |  21.9 KB  |  467 lines

  1.  
  2.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  3.  
  4.      NAME
  5.           demobook - a collection of groups of demos
  6.  
  7.      SYNOPSIS
  8.           demobook [book-file] [-hide]
  9.  
  10.      DESCRIPTION
  11.           Demobook is a collection of groups of demos.  To bring up
  12.           this demo using the default data file, enter
  13.  
  14.           demobook /usr/demos/data/demobook/book.out
  15.  
  16.           Each book contains one or more pages.  You can move through
  17.           the book by turning a single page.  The demos are
  18.           represented by icons on a page.  The icon can be either a
  19.           WorkSpace icon, created with iconsmith, or it can be a small
  20.           rgb image (rgb images are only useful on machines that do
  21.           texture mapping).  In the alphabetical book, all of the
  22.           demos are listed alphabetically.  All of the other books are
  23.           completely customizable.  The demos can be grouped based on
  24.           market segment, functionality, or user preference.  Each
  25.           demo has keywords that will eventually be used to group
  26.           them.  A keyword can be anything from a machine feature that
  27.           this demo illustrates, i.e., texture mapping, to a market
  28.           segment where this demo is extremely effective.
  29.  
  30.           Customizing the environment is very easy.  Adding new demos
  31.           or books to the book is accomplished by filling out a short
  32.           form.  These are under the Demos and Books Menus.  The
  33.           current book can be deleted by selecting Delete Book from
  34.           the Book Menu.  Demos can be removed from a book by
  35.           selecting Delete Demo from the Demos Menu.  Once a demo
  36.           environment has been created, it can be saved in a file on
  37.           the disk. The demobook can also create a tape containing
  38.           everything needed for this book.  It uses the information
  39.           you provide when adding demos to make sure that the
  40.           executable and all supporting files are written to tape.
  41.           This is why it is important to completely fill out the form
  42.           when adding demos.  Currently, the demobook can not parse
  43.           the command to find out what files are necessary to run the
  44.           demo.  You must provide this information at the bottom of
  45.           the form.
  46.  
  47.      OPTIONS
  48.           book-file     The name of the data file containing the list
  49.                         of demos and books and the information which
  50.                         demobook requires for each.
  51.  
  52.           -hide         Does not display icons for demos which will
  53.                         not run because they are not installed on the
  54.                         particular system.
  55.  
  56.      Page 1                                          (printed 5/14/93)
  57.  
  58.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  59.  
  60.      OPERATIONS
  61.         Starting demobook
  62.           In order to use the demobook, you have to give it a data
  63.           file.  You can either do this on the command line,
  64.  
  65.           demobook /usr/demos/data/demobook/book.out
  66.  
  67.           or start up the demobook and then use the Open command under
  68.           the File Menu.  Demobook resides in /usr/demos/bin.  The
  69.           book.out file shipped with demobook is in
  70.           /usr/demos/data/demobook.  We suggest that you keep this
  71.           file as it was shipped and save your customizations in a
  72.           different file (Save As under the File Menu).  An
  73.           environment variable $DEMOS is used to specify the demo home
  74.           directory, such as, /usr/demos.  This allows you to load the
  75.           demos someplace other than /usr/demos.  You can also put the
  76.           demos in any directory on any disk you want and link that
  77.           directory to /usr/demos.
  78.  
  79.           After demobook starts up, you will see brown shelves.  If
  80.           you have already loaded the data file, you will also see
  81.           books on the shelves. If you have not loaded the data file,
  82.           you will see empty shelves. To load a data file, use the
  83.           Open command under the File Menu.
  84.  
  85.         Opening a Book
  86.           Demobook is actually a collection of books full of demos.
  87.           To open a book, click on it with the left mouse button.  Now
  88.           you are watching it flip out from the shelf and open up.  If
  89.           you do not want to watch the book flip out from the shelf,
  90.           click on it with the middle mouse button.  If you want to
  91.           close the book, select the Close Book command in the Options
  92.           Menu or click the right mouse button.  Use the Zoom
  93.           Left/Right commands in the Options Menu to zoom in on the
  94.           left or right pages.  While you are zoomed in on a
  95.           particular page, you can only access demos on that page.
  96.           The Zoom Out command in the Options Menu will zoom you out
  97.           when you wish.
  98.  
  99.         Turning Pages
  100.           Each book contains one or more pages with up to twenty
  101.           icons.  Any page with icons on either side can turn.  When
  102.           you move the cursor over the left or right edges of the open
  103.           book, if that page can turn, you will notice the cursor
  104.           shape change and the book edges highlight.  Click once with
  105.           the left mouse button to turn the page.  If you do not want
  106.           to watch the page turn, click once with the middle mouse
  107.           button.
  108.  
  109.         Icons
  110.           The icons on the pages are WorkSpace icons, created with
  111.           iconsmith. If your machine does texture mapping, you may
  112.  
  113.      Page 2                                          (printed 5/14/93)
  114.  
  115.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  116.  
  117.           specify small rgb images for the icons.  In most books, you
  118.           can move the icons around on the page by clicking on them
  119.           with the left mouse button, holding the mouse button down,
  120.           and dragging the icon to a new position on the page.  One of
  121.           the books on the shelf contains an alphabetical list of all
  122.           of the demos in all of the books.  Icons in this book can
  123.           not be rearranged on the page.
  124.  
  125.         Starting a Demo
  126.           To start a demo, double click on the icon with the left
  127.           mouse button. This will make a system(3S) call with the demo
  128.           command.  The system(3S) call sends the demo command to
  129.           sh(1).  The demo command is the text provided in the Command
  130.           text area when the demo was added to the book.
  131.  
  132.         Adding a Demo
  133.           To add a demo to the book, use the Add Demo command under
  134.           the Demos Menu.  This will bring up the add demo form.  You
  135.           must supply the following:
  136.  
  137.           demo name     printed under the icon in the book
  138.  
  139.           command       what you would type on the command line to run
  140.                         the demo.  Use pathnames, as you can not
  141.                         assume that everyone will run demobook from
  142.                         /usr/demos.  The command can be anything that
  143.                         would run in a shell.  There is a limit of 300
  144.                         characters. Shell commands that would be
  145.                         separated by a return in a window shell can be
  146.                         separated by semicolons.  The command can also
  147.                         include a call to a script.
  148.  
  149.           icon file names
  150.                         the name of an icon file created with
  151.                         iconsmith and, optionally, an rgb image file
  152.                         about 100 pixels square to use as an icon on
  153.                         machines that do texture mapping.  We use only
  154.                         iconsmith icons because the texture mapped
  155.                         icons are noticeably slower on some low-end
  156.                         systems.
  157.  
  158.           keywords      you can select keywords from the list
  159.                         provided, or enter your own.  Keywords are
  160.                         used by the index and to group demos.
  161.  
  162.           list of file names
  163.                         this is very important for transporting the
  164.                         demobook you are creating, and for determining
  165.                         which demos will run on a system.  This is the
  166.                         information that demobook uses to write the
  167.                         tape, so you must provide full pathnames.
  168.                         This list should include the executable, any
  169.  
  170.      Page 3                                          (printed 5/14/93)
  171.  
  172.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  173.  
  174.                         files that the demo requires to run, and data
  175.                         files.  Demobook checks the existence of these
  176.                         files to determine if the demo will run.
  177.  
  178.           Click on the Done Button when finished.
  179.  
  180.         Editing a Demo
  181.           When a book is open, one click on an icon selects that icon,
  182.           making the demo the current demo.  The information that
  183.           demobook stores about this demo can now be edited.  Use the
  184.           Edit Demo Info command under the Demos Menu.  This will
  185.           bring up a form similar to the Add Demo form, but it will be
  186.           filled in.  You can change any of this information.  Click
  187.           on the Done Button when finished.
  188.  
  189.         Deleting a Demo
  190.           To delete a demo, select the demo by clicking once on it
  191.           with the left mouse button, and then choose Delete Demo from
  192.           the Demos Menu. The demo will be deleted from the book that
  193.           is open, with one exception.  You can not delete a demo in
  194.           the alphabetical book if the demo is in another book.  You
  195.           will have to find the demo in the other book and delete it
  196.           from there first.
  197.  
  198.         Adding a Book
  199.           Add a new book with the Add Book command under the Books
  200.           Menu. This brings up the add book form, part of which is a
  201.           blank yellow area.  Add demos to the book by dragging them
  202.           from the main demobook window to the yellow region of the
  203.           add book window.  The icons will be drawn in the yellow part
  204.           of the window and they will remain in the original place in
  205.           the demobook window.  You can add an unlimited number of
  206.           demos to a new book.  You can also add one demo multiple
  207.           times.  Eventually the icons for the demos will run past the
  208.           edge of the yellow area of the window.  Even though you can
  209.           no longer see the icons as the demos are added to the book,
  210.           they are still being added.  In the form part of the window,
  211.           you must provide the following:
  212.  
  213.           name          this will appear on the spine of the book
  214.  
  215.           keywords      just like giving keywords to a demo
  216.  
  217.           Click on the Done Button when finished.
  218.  
  219.         Editing a Book
  220.           Click once with either the left or middle mouse button on a
  221.           book on the shelf to open the book.  Now it becomes the
  222.           current book, and can be edited.  Use the Edit Book Info
  223.           command under the Books Menu.  This brings up the edit book
  224.           window.  You may add more demos to this book by dragging
  225.           them from the main demobook window to the yellow area of the
  226.  
  227.      Page 4                                          (printed 5/14/93)
  228.  
  229.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  230.  
  231.           window that contains the other icons.  You may also change
  232.           any of the information in the form part of the window.
  233.           Click on the Done Button when finished.
  234.  
  235.         Deleting a Book
  236.           First make a book the current book by clicking on it with
  237.           either the left or middle mouse button.  Choose Delete Book
  238.           from the Books Menu.  This book will be deleted.  The demos
  239.           that were inside it can still appear in the other books in
  240.           this demobook.
  241.  
  242.         The Index
  243.           The index is a list of all of the keywords, demo names, and
  244.           book names in demobook.  Selecting a demo name in the index
  245.           will show you in which books it is found and what its
  246.           keywords are.  Selecting a book name will display the demos
  247.           contained in that book.
  248.  
  249.         Creating a Tape
  250.           The demobook can also create a tar tape containing
  251.           everything needed to recreate this book and run all of the
  252.           demos in it on the destination machine.  It uses the
  253.           information you provide when adding demos to make sure that
  254.           the executable and all supporting files are written to tape.
  255.           This is why it is important to completely fill out the form
  256.           when adding demos. Currently, the demobook can not parse the
  257.           command to find out what files are necessary to run the
  258.           demo.  You must provide this information in the Executable
  259.           and Data Files section of the form.
  260.  
  261.         Saving a File
  262.           There are two ways to save a file.  Both are under the File
  263.           Menu. If you choose save, demobook will save its current
  264.           information over the most recently accessed data file.  This
  265.           could be the file you read when you started the demobook, or
  266.           the file that you most recently saved.  If you choose Save
  267.           As, you must select Ascii or Binary format, and then
  268.           demobook will ask you for the name of the file you want to
  269.           save.
  270.  
  271.      MENUS
  272.         File Menu
  273.           Open -- Opens a book file.  Right now, this can only be used
  274.           when the book is empty.
  275.  
  276.           Append -- Appends a book file to add more books to the
  277.           shelves.
  278.  
  279.           Save -- Saves the book file into the current file.  This is
  280.           either the file that was read into the book, or the file
  281.           specified in the most recent Save As command.
  282.  
  283.      Page 5                                          (printed 5/14/93)
  284.  
  285.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  286.  
  287.           Save As -- Lets the user specify a filename before saving
  288.           the book. Also changes the current file name for the book.
  289.           After a Save As, the Save command will save the file in the
  290.           new file name.  Binary or Ascii format must be specified.
  291.  
  292.           Create a Tape -- Will write all of the files for Demobook
  293.           onto the local tape device in tar format.
  294.  
  295.           Quit -- Exits the program.  If changes have been made to the
  296.           data in the book and a file has not been saved, they will be
  297.           lost.
  298.  
  299.         Demos Menu
  300.           Add Demo -- Brings up the interface for adding a demo.  The
  301.           user enters the name that will appear under the icon in the
  302.           book, what would be typed on the command line to start the
  303.           demo, filenames for the icons (both Workspace icon and a 100
  304.           X 100 image file).  The user can choose keywords for the
  305.           demo from the list of keywords that the book already knows,
  306.           or new ones can be typed into the slot above the list of
  307.           keywords for this demo.  The Next Button on the interface
  308.           will add the current demo to the book and prepare the
  309.           interface for the next demo to be added.
  310.  
  311.           Delete Demo --  Deletes the selected demo.  A demo can not
  312.           be removed from the alphabetical book if it is a member of
  313.           any other book.
  314.  
  315.           Edit Demo Info -- Displays the information for the selected
  316.           demo in the add demos interface, where it can be edited.
  317.  
  318.         Books Menu
  319.           Add Book -- Brings up the window where the user creates a
  320.           new book by dragging icons from the currently open book in
  321.           the demobook main window into the yellow area of the add
  322.           book window. In the form part of the window, the book must
  323.           be given a title. The title is displayed on the spine of the
  324.           book.  Keywords can be associated with a book.  The Next
  325.           Button on the interface will save the book currently being
  326.           added and prepare the interface for the next book that will
  327.           be added.
  328.  
  329.           Delete Book -- Deletes the current book.  The current book
  330.           is the book which is open in the main window.
  331.  
  332.           Edit Book Info -- Brings up the book information window
  333.           where the entries for the current book can be edited.   This
  334.           is the way to add demos to a book that is already in the
  335.           demobook.
  336.  
  337.         Options Menu
  338.           Show All Demos -- Show All Demos is a toggle which will hide
  339.  
  340.      Page 6                                          (printed 5/14/93)
  341.  
  342.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  343.  
  344.           demos whose executable or data files are not present on the
  345.           system.  The icons for these demos will not be shown, but
  346.           they will still exist in the book.  Show All Demos will let
  347.           you see icons for all of the demos in the book whether or
  348.           not they will run.  Please note, currently there is no
  349.           mechanism for describing to the Demobook what GL features a
  350.           demo needs to run.  For instance, if flip, which needs a
  351.           zbuffer to run, and its data files are installed on a system
  352.           with no zbuffer, they will show up in Demobook even when the
  353.           user has chosen to not Show All Demos, but when flip runs,
  354.           it will put up a window that says that it will not run
  355.           without zbuffer.
  356.  
  357.           Close Book -- Closes the currently open book.
  358.  
  359.           Zoom Left -- Will zoom the view of the book to the left
  360.           page.
  361.  
  362.           Zoom Right -- Will zoom the view of the book to the right
  363.           page.
  364.  
  365.           Zoom Out -- Returns to the view of both pages of the book.
  366.  
  367.         Help Menu
  368.           Demobook -- Brings up this document.
  369.  
  370.           Demo -- Brings up a document with information about the
  371.           selected demo.
  372.  
  373.           Book -- Brings up a document with information about the
  374.           selected book.
  375.  
  376.           Index -- Displays a scrollable list of book names, demo
  377.           names, and keywords.  Selecting a demo name in the index
  378.           will show you in which books it is found and what its
  379.           keywords are.  Selecting a book name will display the demos
  380.           contained in that book.
  381.  
  382.      MOUSE BUTTONS
  383.           Left Mouse - Single Click
  384.           Selects icons.   When an icon is selected,  that icon can be
  385.           deleted or its information can be edited from the Demo Menu.
  386.           Turn the page by clicking on the page edges, if they are
  387.           highlighted when the cursor is over them.  When all of the
  388.           books are closed and on the shelf, open a book by clicking
  389.           on it.  To close a book, use the Close Book command in the
  390.           Options Menu or click the right mouse button.  Use the left
  391.           mouse to watch the animated motion of the pages turning and
  392.           the book flipping out.
  393.  
  394.           Left Mouse - Double Click
  395.           Double click on an icon to run that demo.
  396.  
  397.      Page 7                                          (printed 5/14/93)
  398.  
  399.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  400.  
  401.           Middle Mouse
  402.           Use the middle mouse to turn pages without watching the
  403.           animated motion.  It works just like the left mouse button.
  404.           Go to the next page by clicking on the highlighted page
  405.           edges.  Open a book without watching it flip off the shelf
  406.           by clicking on it.
  407.  
  408.           Right Mouse
  409.           Closes the currently open book.
  410.  
  411.      INTERFACES
  412.           Text Areas -- When the mouse is over the area, a blinking
  413.           black cursor will appear and you can type into the text
  414.           area.
  415.  
  416.           Scrolling Lists -- The scrolling lists are typical Motif
  417.           scrolling lists with sliders.
  418.  
  419.      RELEASE NOTES
  420.           There were three main reasons for developing a new demo
  421.           environment, and the demobook answers all of them.  First of
  422.           all, it is very easy to add new demos to the book and to
  423.           organize them in a way that makes sense to you, the person
  424.           who gives the demos.  Secondly, the demos are easy to find
  425.           because you can put them anywhere you want.  There is also
  426.           the index that makes it easy to look up demos.  Finally, the
  427.           demobook will write a tape so that you can build an
  428.           environment and easily transport it to another machine.
  429.  
  430.           To get started, run demobook in /usr/demos/bin.  You can
  431.           either put the input file name on the command line, or you
  432.           can use the file menu to open one.  The default input file
  433.           is /usr/demos/data/demobook/book.out. In general, use the
  434.           left mouse button to click on icons, books, menus, and the
  435.           page edges.  Also see the "Demobook" item under the Help
  436.           Menu.
  437.  
  438.           While every effort was made to get rid of all of the bugs in
  439.           the demobook, since it is software, there are still a few in
  440.           there. Also, there are features that are not yet fully
  441.           implemented.  These release notes are an effort to let you
  442.           know where the software stands. If you find bugs or have
  443.           suggestions for improvements to the demobook, please contact
  444.           Michelle Boyd, (415) 390-5284 or michelle@esd.sgi.com.
  445.  
  446.           When you are adding demos, you must put the name of the
  447.           executable and any data files that the demo needs to run in
  448.           the file list at the bottom of the form.  This is the only
  449.           way that the book knows what files to write on a tape.  Full
  450.           path names are best.  If you run the demobook from a
  451.           directory other than /usr/demos/bin, the correct files will
  452.           be written when you write the tape.
  453.  
  454.      Page 8                                          (printed 5/14/93)
  455.  
  456.      DEMOBOOK(6D)              UNIX System V              DEMOBOOK(6D)
  457.  
  458.           The tape is created on the local tape drive.  It is an error
  459.           if there is no local tape drive.  If you do have a local
  460.           tape drive, you must first put the tape in the tape drive.
  461.  
  462.      AUTHOR
  463.           Michelle Boyd, (415)390-5284, michelle@esd.sgi.com
  464.  
  465.      Page 9                                          (printed 5/14/93)
  466.  
  467.